package com.asialjim.wechat.message;

/**
 * <h1><em>ASIAL JIM JAVA DOC</em></h1><hr/>
 * <h2>CLASS DESCRIPTION <i>[ NAME: WeChatMessage ]</i></h2><strong>
 * <p> interface of we chat message
 * </strong><p><p><em>Copyright &copy; Asial Jim Co., LTD</em><hr/>
 *
 * @author Asial Jim &nbsp;&nbsp; <span>Email:<a href="mailto:asialjim@hotmail.com">asialjim@hotmail.com</a> &nbsp;&nbsp; <a href="asialjim@qq.com">asialjim@qq.com</a></span>
 * @version 1.0.0
 * @since 2021/1/26   &nbsp;&nbsp; JDK 8
 */
public interface WeChatMessage {

    /**
     * <h3>METHOD DESCRIPTION <i>[ NAME: getToUserName ]</i></h3>
     * name (openId) of user who receive we chat message
     * @return {@link String openId}
     * @author Asial Jim &nbsp;&nbsp;<span>Email:asialjim@hotmail.com &nbsp;&nbsp; asialjim@qq.com</span>
     * @since 2021/1/26 10:37
     */
    String getToUserName();

    /**
     * <h3>METHOD DESCRIPTION <i>[ NAME: getFromUserName ]</i></h3>
     * name (openId) of user who send we chat message
     * @return {@link String openId}
     * @author Asial Jim &nbsp;&nbsp;<span>Email:asialjim@hotmail.com &nbsp;&nbsp; asialjim@qq.com</span>
     * @since 2021/1/26 10:38
     */
    String getFromUserName();

    /**
     * <h3>METHOD DESCRIPTION <i>[ NAME: getCreateTime ]</i></h3>
     * create time of we chat message
     * @return {@link Long create time}
     * @author Asial Jim &nbsp;&nbsp;<span>Email:asialjim@hotmail.com &nbsp;&nbsp; asialjim@qq.com</span>
     * @since 2021/1/26 10:39
     */
    Long getCreateTime();

    /**
     * <h3>METHOD DESCRIPTION <i>[ NAME: getMsgType ]</i></h3>
     * message type of we chat message
     * @return {@link String message type}
     * @author Asial Jim &nbsp;&nbsp;<span>Email:asialjim@hotmail.com &nbsp;&nbsp; asialjim@qq.com</span>
     * @since 2021/1/26 10:40
     */
    String getMsgType();
}